Parts of rule and data forms

Indicates whether this form contains a locked (read-only) instance.

• The Edit label appears if this rule was locked or checked out using the Check out or Check out to branch buttons.
• The Private Edit label appears if the rule was checked out using the Private edit button. This label also appears for all data instance forms.
• A f form has no label when its record is read-only. Examples include: rules in a locked ruleset version; rules checked out by another operator, rules in a class you cannot update, and rules in an unlocked ruleset that are not checked out by you. The Check out(or Private edit) and Save As buttons appear on the toolbar.

The mode automatically updates as the form changes states; you cannot edit it directly in the form header.

See Rule and data form toolbar.

A common name associated with a rule or data instance based on object class. For example, rules of class Rule-Obj-Flow have type “flow”. Data instances of class Data-Admin-Operator-ID have type “Operator ID”.

See Rules by form name and Data classes by form name for the complete lists.

Contains the required Short Description field. It aids other developers in identifying the purpose and source of this instance. To edit the name, click it and modify the text in the pop-up dialog. Click OK to save your edits.

Note: For flows, flow actions, application rules, and certain class rule instances, the text you enter here may be visible to users of your application. See Creating good Short Descriptions.

Displays this record's availability. To change the setting, click the label to open the pop-up dialog. Make your selection in the Availability drop-down menu and click OK. See available rule and Changing rule status and availability.

Appears if the record has a status setting. To change the setting, click the label. In the pop-up dialog, make your selection in the Status drop-down menu and click OK.

As a best practice, leave the Status field blank except in special situations. Select:

• API — Select API to associate this rule with one of Pega's interfaces. Select an interface. (Traditionally, this designation indicates an intent not to change the functionality of the rule in future releases.)
• Template — Select Template to mark this rule as a template, to appear in the Template field. This is useful for harness and flows. (See step 4 above)
• Extension — Select Extension to mark this rule as an extension point of a framework, to be overridden in each implementation of the framework. Extensions are specified by framework developers for rules that are intended to be overwritten or copied down to the implementation class. Select Designer Studio > Applications > Inventory > Extension Points to view rules with this status.

Note: The value you select for this property (Rule-.pyMethodStatus) does not affect validation, execution, record resolution, or migration of the record.

A circumstanced rule is a variant or specialized version of a base rule.

The Circumstanced label appears if the record is circumstanced by property, date, or date range. To see the circumstance values, click the label.

For a description of the settings, see Completing the Specialization form.

This label is also displayed on the base version of the record. When you click the label, the This is a base version pop-up message appears.

Key parts are portions of a record’s pzInskey, such as pyClassName (applies to class) and pyRuleName (name of record), that are displayed in the header.

You cannot alter the value of record key parts directly on the form. You define key parts in the Create, Save As, or Specialization forms. See:

• Completing the Create form
• Completing the Save As form
• Completing the Specialization form

Which properties form the key part, and in which order, for objects of a specific class are determined in the class rule:

• For a data instance, the key part fields uniquely identify the instance within the class. For example, the Data-Admin-OrgDivision class has two key parts, labeled Organization Name and Division Name on the Division form. Only one instance of this class with Acme.org as the first key part and Marketing as the second key part can exist in your system.
• For a rule instance, the key part fields uniquely identify the instance within a ruleset, version, circumstance, and other qualifiers. For example, the Property form has two key parts labeled Applies To and Record Identifier. Your system might contain multiple properties with Assign- as the Applies To key part and Payload as the Name key part, in different rulesets or versions.

Identifies the ruleset and version that apply to this record. Records in rule set names beginning with the five characters Pega- are reserved and locked. Click the link to open the ruleset.

• If this record is in a branched rule set, the base rule set and branch name appear in this area. Click the name to open the branch rule set.
  
• If this is a data instance or application rule, the associated ruleset and Edit link appear in this area. If there is no rule set specified, the field displays No Associated RuleSet. Click Edit to change or add a rule set.